.\"                                      Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2022  fheroes2 team <fhomm2@gmail.com>
.\"
.TH fheroes2 6 "May 2022"
.\" Please adjust this date whenever revising the manpage.
.SH NAME
fheroes2 \- free remake of Heroes of Might and Magic II game engine
.SH SYNOPSIS
.B fheroes2
.SH DESCRIPTION
\fBfheroes2\fR is a free implementation of Heroes of Might and Magic II game engine,
a classic turn-based strategy, with significant improvements in the gameplay, graphics
and logic (including support for high-resolution graphics, improved AI,
numerous fixes and UI improvements).
.PP
To play the game, original resources from a demo or full version are needed.
.SH GAME DATA PATHS 
The following directories are searched as data root:
#_SG
.TP
.B @FHEROES2_DATA@
The system-wide location that can be accessed by all users.
#_EG
.TP
.B FHEROES2_DATA
This environment variable can contain a path to a directory with game files.
.TP
.B Current working directory
.TP
.B @data@
Per-user data directory.
This path can be overridden by XDG_DATA_HOME environment variable.
.PP
The game resources which searched in these directories:
.TP
.B data/*.agg
Original assets (required).
.TP
.B files/data/*.h2d
Additional non-original assets from fheroes2 project.
.TP
.B files/lang/*.mo
Translations from fheroes2 project.
.TP
.B files/soundfonts/*
Additional SoundFont files for MIDI synthesizer. sf2 and sf3 formats are supported.
.TP
.B maps/*
.br
Single scenarios and campaigns (h2c, hxc, mp2, mx2 files).
.TP
.B music/*
CD audio music tracks which are ripped in mp3, ogg or flac formats.
The tracks should be named as "homm2_XX.ext" or "TrackXX.ext" where XX is a track number and ext is an extension.
Numeration starts from "01" for the "homm2_" prefix and from "02" for the "Track" prefix.
.TP
\fBanim/*.smk\fP or \fBanim2/*.smk\fP or \fBheroes2/anim/*.smk\fP
Video files.
.SH ENVIRONMENT
.TP
.B FHEROES2_DATA
See the section \fBGAME DATA PATHS\fR above.
.SH FILES
.TP
.B @config@
This directory contains per-user configuration files.
\fBfheroes2.cfg\fR is for game options and \fBfheroes2.key\fR is for hotkeys.
This path can be overridden by the XDG_CONFIG_HOME environment variable.

